InstantSearchClient Docs

InstantSearchClient Reference API Client Reference

API Client

Client
Entry point into the Swift API.
See more
Declaration
Swift

@objcMembers public class Client : AbstractClient

Index
A proxy to an Algolia index.

Note
You cannot construct this class directly. Please use Client.index(withName:) to obtain an instance.
See more
Declaration
Swift

@objcMembers public class Index : NSObject, Searchable

Query
Describes all parameters of a search query.

There are two ways to access parameters:
1. Using the high-level, typed properties for individual parameters (recommended).
2. Using the low-level, untyped accessors parameter(withName:) and setParameter(withName:to:) or (better) the subscript operator. Use this approach if the parameter you wish to set is not supported by this class.
Warning
All parameters are optional. When a parameter is nil, the API applies a default value.
See more
Declaration
Swift

@objc open class Query : AbstractQuery

BrowseIterator
Iterator to browse all index content.

This helper takes care of chaining API requests and calling back the completion handler with the results, until:
- the end of the index has been reached;
- an error has been encountered;
- or the user cancelled the iteration.
See more
Declaration
Swift

@objcMembers public class BrowseIterator : NSObject